Fzzy Config/me.fzzyhmstrs.fzzy_config.validation.number/ValidatedByte

ValidatedByte

class ValidatedByte @JvmOverloads constructor(defaultValue: Byte, maxValue: Byte, minValue: Byte, widgetType: ValidatedNumber.WidgetType = if(maxValue == Byte.MAX_VALUE || minValue == Byte.MIN_VALUE) WidgetType.TEXTBOX else WidgetType.SLIDER) : ValidatedNumber<Byte>

A validated byte number. This field is a wrapper of bytes that is both a java.util.function.Supplier and java.util.function.Consumer of type Byte

Author

fzzyhmstrs

Since

0.1.0

Parameters

defaultValue

Byte. the default value of this wrapper

maxValue

Byte. the maximum allowed value, inclusive

minValue

Byte. the minimum allowed value, inclusive

Samples

import me.fzzyhmstrs.fzzy_config.validation.number.*

fun main() { 
   //sampleStart 
   //ValidatedByte. Defaults to 4, allowable range 8 to 0. Uses a Slider widget
val validatedByte = ValidatedByte(4, 8, 0)

//You can define the widget type of ValidatedByte, either a Slider or a "textbox"
val textBoxByte = ValidatedByte(4, 8, 0, ValidatedNumber.WidgetType.TEXTBOX)

//ValidatedByte built from a min and max. Uses the minimum value as the default. can use either a Slider or a "textbox" widget.
val minMaxByte = ValidatedByte(-16, 16)

//unbounded ValidatedByte. Can be any valid byte value. Widget forced to "textbox" style
val unboundedByte = ValidatedByte(4)

//validation-only Byte (unless your default happens to be 0)
val emptyByte = ValidatedByte()

//fields and sections have lang keys based on their "location" in the Config class graph.
//Lange key composition is as follows
//1. the namespace of the config id: (my_mod)
//2. the path of the config id: (my_mod.my_config)
//3. any parent ConfigSection field names as declared in-code: (my_mod.my_config.subSection)
//4. the setting field name as declared in-code: (my_mod.my_config.subSection.fieldName)
val fieldLang = """
{
    "_comment1": "the lang for an example 'fieldName' setting in a config inside section 'subSection'",
    "my_mod.my_config.subSection.fieldName": "Very Important Setting",
    "my_mod.my_config.subSection.fieldName.desc": "This very important setting is used in this very important way."
}
""" 
   //sampleEnd
}

Constructors

ValidatedByte

@JvmOverloads

constructor(minValue: Byte, maxValue: Byte, widgetType: ValidatedNumber.WidgetType = WidgetType.SLIDER)

A validated byte number with a default selected from the min of the allowable range.

constructor(defaultValue: Byte)

an unbounded validated byte number.

constructor()

an unbounded validated byte number with a default of 0b

@JvmOverloads

constructor(defaultValue: Byte, maxValue: Byte, minValue: Byte, widgetType: ValidatedNumber.WidgetType = if(maxValue == Byte.MAX_VALUE || minValue == Byte.MIN_VALUE) WidgetType.TEXTBOX else WidgetType.SLIDER)

Types

Restrict

annotation class Restrict(val min: Byte = Byte.MIN_VALUE, val max: Byte = Byte.MAX_VALUE)

Annotation-driven validation for Bytes

Properties

translatableEntryKey

open override var translatableEntryKey: String

Functions

open override fun accept(input: Byte)

updates the wrapped value. NOTE: this method will push updates to an UpdateManager, if any. For in-game updating consider validateAndSet

addListener

open fun ~~addListener~~(listener: Consumer<ValidatedField<Byte>>)

Attaches a listener to this field. This listener will be called any time the field is written to ("set"). accept, validateAndSet, setAndUpdate and so on will all call the listener.

andThen

open fun andThen(p0: Consumer<in Byte>): Consumer<Byte>

codec

fun codec(): Codec<Byte>

Provides a Codec representing the value type of this validation, backed by the validators within as applicable

copyStoredValue

open fun copyStoredValue(): Byte

Copies the stored value and returns it.

copyValue

open fun copyValue(input: Byte): Byte

Copies the provided input as deeply as possible.

descriptionKey

open override fun descriptionKey(): String

translation key of this Translatable's description. the "description" in-game, the descriptions Enchantment Descriptions adds to enchantment tooltips are a good example.

deserializedChanged

open fun deserializedChanged(old: Any?, new: Any?): Boolean

Specialized equals method for determining if a newly deserialized value is effectively equal to its old counterpart.

flags

open override fun flags(): Byte

get

open override fun get(): Byte

supplies the wrapped value

getDefault

fun getDefault(): Byte

Provides this validations default value

getEntryKey

abstract fun getEntryKey(): String

hasDescription

open override fun hasDescription(): Boolean

Whether this Translatable has a valid description

hasFlag

open override fun hasFlag(flag: EntryFlag.Flag): Boolean

hasPrefix

open fun hasPrefix(): Boolean

Whether this Translatable has a valid prefix

hasTranslation

open fun hasTranslation(): Boolean

Whether this Translatable has a valid translation

instanceEntry

open override fun instanceEntry(): ValidatedByte

creates a deep copy of this ValidatedByte return ValidatedByte wrapping the current byte value and validation restrictions

listenToEntry

open override fun listenToEntry(listener: Consumer<Entry<Byte, *>>)

Attaches a listener to this field. This listener will be called any time the field is written to ("set"). accept, validateAndSet, setAndUpdate and so on will all call the listener.

map

fun <N> map(to: Function<Byte, out N>, from: Function<in N, Byte>): ValidatedField<N>

Maps this validation to a new convertible type. The default value will be applied from this delegates current storedValue

fun <N> map(defaultValue: N, to: Function<Byte, out N>, from: Function<in N, Byte>): ValidatedField<N>

fun <N> map(to: Function<Byte, out N>, from: Function<in N, Byte>, defaultValue: Byte): ValidatedField<N>

Maps this validation to a new convertible type.

pairWith

fun <B> pairWith(other: Entry<B, *>): ValidatedPair<Byte, B>

Pairs this validation with another validation into one ValidatedPair

prefix

open fun prefix(fallback: String? = null): MutableText

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.

prefixKey

open override fun prefixKey(): String

translation key of this Translatable's inline prefix text. Unlike descriptions, which are usually displayed in-tooltips, prefixes are displayed inline in the config screen itself

prepare

open fun prepare(scope: String, groups: LinkedList<String>, annotations: List<Annotation>, globalAnnotations: List<Annotation>)

Called in the prepare stage of screen building to perform any necessary pre-entry-creation tasks.

setEntryKey

abstract fun setEntryKey(key: String)

toCondition

open fun toCondition(condition: ValidatedField<Boolean>, fallback: Supplier<Byte>): ValidatedCondition<Byte>

Convert this field to a ValidatedCondition using the provided validation as a supplier. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied.

open fun toCondition(condition: ValidatedCondition.Condition, fallback: Supplier<Byte>): ValidatedCondition<Byte>

open fun toCondition(condition: Supplier<Boolean>, failMessage: Text, fallback: Supplier<Byte>): ValidatedCondition<Byte>

Convert this field to a ValidatedCondition. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied.

open fun toCondition(scope: String, failMessage: Text, fallback: Supplier<Byte>): ValidatedCondition<Byte>

Convert this field to a ValidatedCondition using the provided scope with a default boolean provider. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied. The provided scope must point to a valid boolean config scope otherwise the initial condition will never pass.

toList

fun toList(vararg elements: Byte): ValidatedList<Byte>

Wraps the provided values into a ValidatedList with this field as validation

fun toList(collection: Collection<Byte>): ValidatedList<Byte>

Wraps the provided collection into a ValidatedList with this field as validation

toSet

fun toSet(vararg elements: Byte): ValidatedSet<Byte>

Wraps the provided values into a ValidatedSet with this field as validation

fun toSet(collection: Collection<Byte>): ValidatedSet<Byte>

Wraps the provided collection into a ValidatedSet with this field as validation

translationKey

open override fun translationKey(): String

translation key of this Translatable. the "name" in-game

trySerialize

fun trySerialize(input: Any?, errorBuilder: MutableList<String>, flags: Byte): TomlElement?

trySet

open override fun trySet(input: Any?)

Attempts to set an arbitrary input into this Entry. Should fail soft if the input is incompatible

update

open fun update(updateMessage: Text)

validateAndSet

open fun validateAndSet(input: Byte): ValidationResult<Byte>

A setter method for the storedValue that first validates the value being set and then stores the post-validation result.

validateAndSetFlagged

open fun validateAndSetFlagged(input: Byte, vararg flag: EntryFlag.Flag): ValidationResult<Byte>

A setter method for the storedValue that first validates the value being set and then stores the post-validation result.

widgetAndTooltipEntry

open fun widgetAndTooltipEntry(choicePredicate: ChoiceValidator<Byte> = ChoiceValidator.any()): ClickableWidget

Builds a new ClickableWidget and applies a tooltip to it. This shouldn't need to be overridden in most cases